Main Page | Class Hierarchy | Class List | Class Members

MPConnectResponse Class Reference

MP Game join game server response (Type: 1). More...

#include <BustaNetInternal.h>

Inheritance diagram for MPConnectResponse:

BustaNetInternalMsg List of all members.

Public Member Functions

 MPConnectResponse (bool accept, char *msg, int cID)
 CONSTRUCTOR.
bool getAcceptance ()
 Returns the acceptance by the server.
char * getReason ()
 Returns the reason for denial by the server.
int getClientID ()
 Returns the client's identification number if accepted.

Detailed Description

MP Game join game server response (Type: 1).

This message is received when a player has attempted to connected to a game server. The server responds with an acceptance or denial to the client's connections attempt. The information about that response is encapsulated in this message.


Constructor & Destructor Documentation

MPConnectResponse::MPConnectResponse bool  accept,
char *  msg,
int  cID
 

CONSTRUCTOR.

Creates an instance of the MPConnectResponse class.

Parameters:
accept Whether or not the client was allowed (true for allowed)
msg The reason for denial if denied
cID The client's identification number if accepted


Member Function Documentation

bool MPConnectResponse::getAcceptance  ) 
 

Returns the acceptance by the server.

Returns whether or not the server allowed the client to join the game. An acceptance of true denotes that the server allowed the client to join the game. A return of false denotes denial of the client's join game request.

Returns:
The server's acceptance of the client (true for allowed, false for denied)

int MPConnectResponse::getClientID  ) 
 

Returns the client's identification number if accepted.

The server provides the client with an identification number for the multiplayer game if the the client was allowed to join the game. This method returns that identification number.

Returns:
The identification number assigned to the client by the server if accepted

char * MPConnectResponse::getReason  ) 
 

Returns the reason for denial by the server.

This method returns the reason why the server has denied the client if the client was denied.

Returns:
The reason for server acceptance response


Generated on Tue Aug 2 22:03:12 2005 for BustaSandwich Networking by  doxygen 1.4.2-20050421